home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / comm / take.zip / TAKE.TXT < prev   
Text File  |  1988-05-28  |  21KB  |  363 lines
  1. Documentation File Take.txt   (revised 5/15/88)
  2.  
  3. >>> Take.Com <<<
  4.  
  5.    - a memory resident screen line grabber for IBM PC work-alikes
  6.         (optimized for use with terminal emulation programs)
  7.    by Mark C. Smith  version 88.5 (test version)
  8.  
  9.  
  10. Introduction
  11.      There are many of us who spend a good portion of our PC time
  12.      interacting with a remote computing network using some kind
  13.      of terminal emulator software.  Unfortunately, the terminal
  14.      emulators I use do not typically have a facility for the
  15.      re-entering lines that are still on the screen or in the
  16.      conversation buffer.  The program Take was designed to provide
  17.      line re-entry with nearly any terminal program (Take is being
  18.      tested with Window - University of Michigan, Procomm 2.4.2, and
  19.      Kermit 2.29b).
  20.  
  21.      Take is memory-resident and provides some interesting features:
  22.       - Editing of a potential re-entry line right on the screen in
  23.          the place the line appears (complete set of editing functions)
  24.       - Active indication of position and insert status using a normal
  25.          cursor.  Insert on is indicated by a full height (block-style)
  26.          cursor.
  27.       - The ability to suspend itself to pass a keystroke pressed
  28.          when Take is "popped up" that Take does not recognize.  This
  29.          allows scrolling of the communication program's text buffer
  30.          without turning Take off and back on again (by passing
  31.          Page Up and Page Down to the program, for example).  This is
  32.          probably Take's most unique and difficult feature that Take
  33.          implements on top of multiple programs using memory resident
  34.          techniques.
  35.       - Transparency to the underlying program.  Edited lines are
  36.          restored on screen, and cursor state is restored as well as
  37.          is possible.
  38.       - Facilities to turn off a resident version of Take and to
  39.          re-start a version turned off (but only one copy of Take
  40.          can be in memory, even if another is turned off).
  41.       - Tight code and fast operation. Take is written entirely in 8086
  42.          assembler, and screen read and writes are directly to video memory.
  43.       - User configuration option for all keys used by Take and for some
  44.          additional options.  This will minimize interference with other
  45.          resident programs.
  46.  
  47. How To Get Take Up And Running
  48.      Take requires an IBM compatible machine, and should run
  49.      on any PC,XT,or ATs that have a CGA,MDA,EGA,or VGA display
  50.      adapter.  Take does directly access the video display
  51.      memory, so this may cause problems in some clones (not
  52.      likely though).  It should run under DOS version 2 or
  53.      greater.  The resident portion of Take steals less
  54.      then 1900 bytes of memory (about half the code for Take
  55.      is for configuration modification/display and installation).
  56.  
  57.      Take is bundled in the .arc format, which means that it
  58.      must be unArced to be useful.  If you are reading this
  59.      documentation (take.txt) you must have already accomplished
  60.      the use of one of the arc programs to extract the files.
  61.      The files contained in the take.arc file are:
  62.          take.txt      - this brief documentation you're reading now
  63.          take.com      - a version of take configured "generically"
  64.                          (no prefix or suffixes; CGA Snow=Yes)
  65.          take_p.com    - a version of take configured for Procomm.
  66.                          (prefix=ALT-F6,suffix=ESC,CGA Snow=No)
  67.          take_w.com    - a version of take configured for Window
  68.                          (communication program of the University
  69.                           of Michigan. prefix=suffix=none,CGA Snow=No)
  70.          take_k.com    - a version of take configured for Kermit.
  71.                          (prefix=none,suffix=END,CGA Snow=No)
  72.      Note than all the _? files were made just by running take.com with
  73.       the configure option.  They are provided as a convenience and as
  74.        examples of use of the prefix and suffix sequences.
  75.  
  76.      The only file you need is one of the .com files.  I suggest copying
  77.      one of the _p,_w,_k files to take.com if you only need one of them.
  78.      The syntax for invoking Take is:
  79.          take -{option}
  80.    or    take /{option}   where {option} is one of BCDIOR (bcdior)
  81.      Action             Syntax    Effect
  82.      ------             ------    ------
  83.      install            take -i   Take is installed (memory resident) if it
  84.                                    is not already installed.  Header and
  85.                                    author contact information is displayed.
  86.      brief install      take -b   Same as i(nstall), except most messages
  87.                                    are suppressed.
  88.      display config.    take -d   Displays the current configuration of Take.
  89.                                    This mostly consists of key definitions.
  90.      configure          take -c   Invokes the interactive configuration
  91.                                    process to set keys and more.
  92.      turn off           take -o   The version of Take resident in memory
  93.                                    is disabled (effectively off).
  94.      restart (turn on)  take -r   The version of Take resident in memory
  95.                                    is re-enabled.
  96.      usage info.        take      (No option specified).  A usage message is
  97.                                    displayed.  If not installed in memory
  98.                                    yet, you will be asked if you want to
  99.                                    install Take.
  100.  
  101. Using Take
  102.      Upon installation, Take becomes memory resident and checks in
  103.      the background for the hotkey to be pressed (the default is
  104.      ALT-F9).  Typically, you will want to install Take (run with
  105.      -i or -b option) and then run your favorite terminal emulation
  106.      program.  Any time you wish to use Take to re-enter a line that
  107.      is on the screen or in the conversation buffer, press the hotkey.
  108.      As long as the video is not in a graphics mode, Take will pop up.
  109.      (Note that Take cannot and will never pop up in a graphics mode).
  110.  
  111.      Take will first send a prefix keystroke sequence to the program
  112.      currently running before popping up.  This prefix feature is for
  113.      programs such as Procomm that require some keystroke(s) to invoke
  114.      conversation buffer scroll-back mode.  (In Procomm, the prefix
  115.      is a single key: ALT-F6).  The prefix can be nothing (as for
  116.      Kermit).  Then Take will place the cursor at the beginning of
  117.      the line above the one it was last on and wait for keystrokes.
  118.      There are several general types of keys that Take handles in
  119.      different ways:
  120.  
  121.        Cancel Key (configurable, default is ESC) - Take will pass a
  122.                     suffix keystroke sequence to the program running
  123.                     underneath and then return control to that program.
  124.                     The suffix sequence is used to restore the program
  125.                     to its previous state.  (In Procomm, ESCAPE is used
  126.                     to drop out of scroll-back mode; in Kermit an END
  127.                     is used to return to the end of the conversation
  128.                     buffer).
  129.  
  130.        Grab Key (configurable, default is RETURN) - Take will pass
  131.                     the suffix keystroke sequence (see above), and then
  132.                     all of the text from the left of the line the cursor
  133.                     is on to the last non-blank character in the line.
  134.                     Presently, no trailing Return is sent at the end
  135.                     of the line.  This option may be added in the
  136.                     future.
  137.  
  138.        Editing Keys (configurable) - Take will perform an editing
  139.                     action on the cursor line.  Possible actions and
  140.                     defaults:
  141.                      Default Key      Action
  142.                      -----------      ------
  143.                      HOME             Move cursor to beginning of line
  144.                      END              Move cursor to end of line
  145.